Skip to content

docs(routing-peers): apply outstanding feedback and expand inbound links#730

Merged
SunsetDrifter merged 3 commits intomainfrom
docs/routing-peers-followup
May 5, 2026
Merged

docs(routing-peers): apply outstanding feedback and expand inbound links#730
SunsetDrifter merged 3 commits intomainfrom
docs/routing-peers-followup

Conversation

@SunsetDrifter
Copy link
Copy Markdown
Contributor

Follow-up to #727. Two commits:

1. Apply outstanding review feedback

Three small edits to the primer that were applied during review of #727 but never made it into the merged commit:

  • Drop the unverified Cloud-specific settings subsection and the related AWS source/destination pitfall bullet
  • Spell out "high availability" in the Masquerade note for clarity

2. Expand inbound cross-links

Surface the primer from 11 high-leverage pages so readers landing in a configuration or scenario guide can find the mental model without backtracking through the sidebar.

  • Index pages (manage/networks, manage/network-routes): move the existing cross-link from the page top into the Routing Peer(s) subsection
  • exit-nodes: cross-link inside the Routing Peer subsection (anchor #exit-node-mode)
  • internal-dns-servers: cross-link under Domain Resources and Routing Peer DNS (anchor #routing-peer-dns-resolution)
  • Procedural / comparison pages: cross-link near the page top with a section-specific anchor — access-control, access-home-devices, cloud-to-on-premise, remote-worker-access, site-to-site, routing-peers-and-kubernetes, manage/integrations/kubernetes

Draft pending review.

- Drop the unverified Cloud-specific settings subsection (AWS/GCP/Azure
  bullets) and the related AWS source/destination pitfall bullet
- Spell out "high availability" in the Masquerade note for clarity
…Work

Surface the routing peer primer from 11 high-leverage pages so readers
landing in a configuration or scenario guide can find the mental model
without having to backtrack through the sidebar.

- Index pages (manage/networks, manage/network-routes): move the
  cross-link from the page top into the Routing Peer(s) subsection,
  where it sits adjacent to existing routing-peer guidance
- exit-nodes scenario: cross-link inside the Routing Peer subsection,
  anchored at #exit-node-mode
- internal-dns-servers: cross-link under Domain Resources and Routing
  Peer DNS, anchored at #routing-peer-dns-resolution
- Procedural and comparison pages (access-control, by-scenario VPN-to-Site
  guides, site-to-site overview, Kubernetes operator, routing peers in
  Kubernetes): cross-link near the page top with section-specific anchors
@SunsetDrifter SunsetDrifter marked this pull request as ready for review May 5, 2026 12:20
Copy link
Copy Markdown
Contributor

@emrcbrn emrcbrn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - other than one abbreviation usage for HA as well

Comment thread src/pages/manage/networks/index.mdx
- Index-page cross-link notes (manage/networks, manage/network-routes):
  expand "HA" to "high availability" in the bullet list
- Primer page: spell out the three remaining HA references in the High
  availability section and Common pitfalls; use "highly available peers"
  as the adjective form
@SunsetDrifter SunsetDrifter requested a review from emrcbrn May 5, 2026 12:38
@SunsetDrifter SunsetDrifter merged commit 6945762 into main May 5, 2026
1 check passed
@SunsetDrifter SunsetDrifter deleted the docs/routing-peers-followup branch May 5, 2026 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants